Option Name

Description

used in all function

XSIGN_OPTION_CHECK_CRL

Eables CRL check. CRL check is not conducted if this is not specified when signing.

NOTE: option XSIGN_OPTION_DONT_CERT_CHAIN can’t be used with this option!

XSIGN_OPTION_SHOW_DLG

This option shows a signature status dialog.

XSIGN_OPTION_DONT_CERT_TIME

Disables certificate time validity checking. Signing might be done with time invalid certificate.

XSIGN_OPTION_DONT_CERT_CHAIN

Disables the certificate chain validity check. Signing might be done with a certificate with incomplete chain.

used with sign() function

SIG_TYPE_DETACHED

Type of signature.

SIG_TYPE_ENVELOPED

Type of signature.

SIG_TYPE_ENVELOPING

Type of signature.

XSIGN_OPTION_EXCLUDE_DS_PREFIX

Excludes “ds:” prefix from <ds:Signature> and its children elements.

XSIGN_OPTION_ONLY_PRIVATE_KEYS

When signing or decrypting, you can use the option XSIGN_OPTION_ONLY_PRIVATE_KEYS to filter certificates displayed by the proXSign® “Choose Certificate” dialog and display only those that have a private key.

XSIGN_OPTION_INCLUDE_REFERENCES

This option includes external references (specified with prop.references) into ds:Object tag.

XSIGN_OPTION_TEMPLATE

This option allows you to generate any XML file and give it to proXSign® to sign it.

XSIGN_OPTION_SMALL_ID

This option inserts “id” instead of “Id” attribute.

XSIGN_OPTION_SIGN_BY_ID

XSIGN_OPTION_SET_DEFAULT_IDS

This option adds default values for Id attributes of elements <Signature>, <SignedInfo> and <SignedValue>.

XSIGN_OPTION_URI_FROM_REFERENCES

This option is used for detached signature in a separate file in combination with property references. With this option when signing the value of property references will become URI attribute value. When verifying, as a source file will be resolved value of property references. That way this option enables the use of an external URI resolver.

used in decrypt()

ENC_TYPE_XML

Used for decrypting a XML file.  

ENC_TYPE_NONXML

Used for decrypting NON XML files.

If you use ENC_TYPE_NONXML option when decrypting a XML file and you have only one node encrypted, you will get as a result only decrypted content, not the whole XML file.

used in encrypt()

XSIGN_OPTION_ENCRYPT_CONTENT

Use this option if you would like to encrypt only the content (text and/or other child elements) of some XML element, not the whole element (including element name and attributes).

XSIGN_OPTION_ENCRYPT_MY_STORE

Only use this option if the certificate you would like to use for encryption is in the Personal store and not in the Other People store.

used in verify() and decrypt()

XSIGN_OPTION_CHECK_XML_SCHEMA

This option enables the W3C XML Signature and Encryption schema verification of the input XML document. In case of a signature verification only XML Signature schema is verified and during decryption both schemas are used. Please note that you have to supply reference to the schema that describes your whole XML document. You don’t need to supply schemas for the XML Signature and Encryption, because proXSign® have it. 

used in sign() and encrypt()

XSIGN_OPTION_INCLUDE_SN_ISSUER

This option is used to insert a certificate ISSUER in <ds:KeyInfo> element.

XSIGN_OPTION_INCLUDE_SUBJECT

This option is used to insert a certificate SUBJECT in <ds:KeyInfo> element.

XSIGN_OPTION_INCLUDE_CERT

This option is used to insert X509 certificate in <ds:KeyInfo> element.

 XSIGN_OPTION_INCLUDE_PUB_KEY

This option is used to insert a certificate PUBLIC KEY in <ds:KeyInfo> element.

XSIGN_OPTION_INCLUDE_SKI

This option is used to insert a certificate SKI in <ds:KeyInfo> element.

XSIGN_OPTION_INCLUDE_CRL

This option is used to insert a CRL LIST in <ds:KeyInfo> element.

XSIGN_OPTION_CHECK_KEY_USAGE

This option checks (filter) for a certificate key usage before it asks user to choose a certificate for signing, encrypting, decrypting or making a SSL connection (timestamp).

encoding and other options

XSIGN_OPTION_UTF8_ENCODING

This option is useful if you have UTF-8 encoded XML inline inside a HTML page and you are using Internet Explorer.

XSIGN_OPTION_PRETTY_PRINT

This option inserts new line characters between signature elements.

XSIGN_OPTION_XADES_ESLOG

Eslog signing / xades.

XSIGN_OPTION_XADES_TIMESTAMP

Used in timestamp : make a XAdES-T timestamp.

XSIGN_OPTION_RETURN_BYTES

Used to return result of signing, encryption or decryption in result as bytes/xml even when SaveFileNames was specified.

XSIGN_OPTION_SAVE_DIALOG

This option causes display of ‘Save’ dialog where user can choose to save the result of signing, encryption or decryption to a local file.